Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Gh-388: Add "What is Python" section to user guide #389

Merged

Conversation

rj77259
Copy link
Member

@rj77259 rj77259 commented Sep 14, 2023

No description provided.

@rj77259 rj77259 linked an issue Sep 14, 2023 that may be closed by this pull request
@CLAassistant
Copy link

CLAassistant commented Sep 14, 2023

CLA assistant check
All committers have signed the CLA.

@tb06904 tb06904 changed the title Adding content for What is Gaffer? in user guide of documentation. Adding content for What is Python? in user guide of documentation. Sep 14, 2023
@rj77259 rj77259 force-pushed the 388-what-is-python-additional-section-to-user-guide branch from f3bd4d0 to 17209b0 Compare September 14, 2023 15:50
docs/user-guide/gaffer-basics/what-is-python.md Outdated Show resolved Hide resolved
docs/user-guide/gaffer-basics/what-is-python.md Outdated Show resolved Hide resolved
docs/user-guide/gaffer-basics/what-is-python.md Outdated Show resolved Hide resolved
docs/user-guide/gaffer-basics/what-is-python.md Outdated Show resolved Hide resolved
docs/user-guide/gaffer-basics/what-is-python.md Outdated Show resolved Hide resolved
docs/user-guide/gaffer-basics/what-is-python.md Outdated Show resolved Hide resolved
Copy link
Member

@GCHQDeveloper314 GCHQDeveloper314 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm wondering if all instances of "Python" should be capitalised. It's inconsistent at the moment. The Python style guide says "The name of our favorite programming language is always capitalized."

Could also split some of the long lines.

@GCHQDeveloper314
Copy link
Member

Would also be good to add a link to the GafferPy API page which is being added in #393. This can be done once that PR is merged.

@GCHQDeveloper314 GCHQDeveloper314 changed the title Adding content for What is Python? in user guide of documentation. Gh-388: Add "What is Python" section to user guide Sep 21, 2023
@GCHQDeveloper314 GCHQDeveloper314 merged commit 51c1757 into v2docs Sep 21, 2023
2 checks passed
@GCHQDeveloper314 GCHQDeveloper314 deleted the 388-what-is-python-additional-section-to-user-guide branch September 21, 2023 16:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

What is Python? - Additional section to User Guide
4 participants